<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Flat UI</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <!-- Loading Bootstrap -->
    <link href="../assets/css/bootstrap.css" rel="stylesheet">

    <!-- Loading Flat UI -->
    <link href="../assets/css/flat-ui.css" rel="stylesheet">
    <link href="../assets/css/github.css" rel="stylesheet">
    <link rel="shortcut icon" href="../assets/images/favicon.ico">

    <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
    <!--[if lt IE 9]>
    <script src="js/html5shiv.js"></script>
    <![endif]-->
  </head>
  <body>


    <div class="container">
      <div class="demo-headline">
        <h1 class="demo-logo">Lettuce
          <small>Behaviour Driven Development for python</small></h1>
      </div>
      <div class="row">
        <div class="span4">
          <div class="sidebar-nav">
            <ul class="share mrl">
              <div class="btn btn-primary btn-block btn-large">
                <h3>Sections</h3>
              </div>
              
              <a class="btn btn-inverse btn-block btn-large"
       href="#contributing-to-the-documentation">
         Contributing to the documentation
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#conventions">
         Conventions
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#language">
         Language
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#line-length">
         Line length
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#headings">
         Headings
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#code-blocks">
         Code blocks
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#links-and-references">
         Links and references
    </a>
  
    
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#install-sphinx">
         Install Sphinx
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#export-documentation-to-html">
         Export documentation to HTML
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#use-doctests-">
         Use doctests!
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#write-doctests">
         Write doctests
    </a>
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#run-doctests">
         Run doctests
    </a>
  
    
  
    
      <a class="btn btn-inverse btn-block btn-large"
       href="#references">
         References
    </a>
  
    
  
              
            </ul>
          </div>
        </div>
        <div class="span8">
          <h1 id="contributing-to-the-documentation" name="contributing-to-the-documentation"><a href="#contributing-to-the-documentation">Contributing to the documentation</a></h1>
<p>This documentation uses <a href="http://sphinx.pocoo.org/" title="None">Python-sphinx</a>. It
uses <a href="http://docutils.sourceforge.net/rst.html" title="None">reStructuredText</a>
syntax.</p>
<h2 id="conventions" name="conventions"><a href="#conventions">Conventions</a></h2><h3 id="language" name="language"><a href="#language">Language</a></h3>
<p>The documentation is written in english.</p>
<h3 id="line-length" name="line-length"><a href="#line-length">Line length</a></h3>
<p>Limit all lines to a maximum of 79 characters.</p>
<h3 id="headings" name="headings"><a href="#headings">Headings</a></h3>
<p>Use the following symbols to create headings: <code>#  *  =  -</code></p>

<p>As an example:</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-1"><span class="c">##################</span>
<span class="n">H1</span><span class="p">:</span> <span class="n">document</span> <span class="nb">title</span>
<span class="c">##################</span>

<span class="o">*********</span>
<span class="n">Sample</span> <span class="n">H2</span>
<span class="o">*********</span>

<span class="n">Sample</span> <span class="n">H3</span>
<span class="o">========</span><span class="p">=</span>

<span class="n">Sample</span> <span class="n">H4</span>
<span class="o">---------</span>

<span class="n">And</span> <span class="n">sample</span> <span class="nb">text</span><span class="p">.</span>
</pre></div>
<p>If you need more than H4, then consider creating a new document.</p>
<h3 id="code-blocks" name="code-blocks"><a href="#code-blocks">Code blocks</a></h3>
<p>Combine a &ldquo;highlight&rdquo; directive and a &ldquo;::&rdquo; to specify the programming
language. As an example:</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-2"><span class="p">..</span> <span class="ow">highlight</span><span class="p">::</span> python

::

  import this
</pre></div><h3 id="links-and-references" name="links-and-references"><a href="#links-and-references">Links and references</a></h3>
<p>On pages which are quite long, use links and references footnotes with
the &ldquo;target-notes&rdquo; directive. As an example:</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-3"><span class="c">#############</span>
<span class="n">Some</span> <span class="n">document</span>
<span class="c">#############</span>

<span class="n">Some</span> <span class="nb">text</span> <span class="n">which</span> <span class="n">includes</span> <span class="n">links</span> <span class="n">to</span> `<span class="n">Example</span> <span class="n">website</span>`<span class="n">_</span> <span class="nb">and</span> <span class="n">many</span> <span class="n">other</span> <span class="n">links</span><span class="p">.</span>

`<span class="n">Example</span> <span class="n">website</span>`<span class="n">_</span> <span class="n">can</span> <span class="n">be</span> <span class="n">referenced</span> <span class="n">multiple</span> <span class="nb">times</span><span class="p">.</span>

<span class="p">(...</span> <span class="n">document</span> <span class="n">content</span><span class="p">...)</span>

<span class="n">And</span> <span class="n">at</span> <span class="n">the</span> <span class="k">end</span> <span class="n">of</span> <span class="n">the</span> <span class="n">document</span><span class="p">...</span>

<span class="o">**********</span>
<span class="n">References</span>
<span class="o">**********</span>

<span class="p">..</span> <span class="n">target</span><span class="o">-</span><span class="n">notes</span><span class="p">::</span>

<span class="p">..</span> <span class="n">_</span>`<span class="n">Example</span> <span class="n">website</span>`<span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="p">.</span><span class="nb">example</span><span class="p">.</span><span class="n">com</span><span class="o">/</span>
</pre></div>
<p>This :doc:documentation page uses this syntax.</p>
<h2 id="install-sphinx" name="install-sphinx"><a href="#install-sphinx">Install Sphinx</a></h2>
<p><a href="http://sphinx.pocoo.org/" title="None">Python-sphinx</a> installation is covered in
:doc:/dev/install.</p>

<p>In other cases, please refer to
<a href="http://sphinx.pocoo.org/" title="None">Python-sphinx</a> documentation.</p>
<h2 id="export-documentation-to-html" name="export-documentation-to-html"><a href="#export-documentation-to-html">Export documentation to HTML</a></h2>
<ul>
<li>  Install <a href="http://sphinx.pocoo.org/" title="None">Python-sphinx</a>.</li>
<li>  Make sure sphinx-build is in your shell&#39;s \$PATH. If you are using
virtualenv as told in :doc:/dev/install, then <strong>activate your
virtual environment</strong>.</li>
<li><p>Go to lettuce folder and use the provided Makefile:</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-4"><span class="n">make</span> <span class="n">documentation</span>
</pre></div></li>
<li><p>HTML documentation is exported to docs/_build/html/.</p></li>
</ul>
<h2 id="use-doctests-" name="use-doctests-"><a href="#use-doctests-">Use doctests!</a></h2>
<p>This documentation uses the <a href="http://sphinx.pocoo.org/ext/doctest.html#module-sphinx.ext.doctest" title="None">Sphinx&#39;s doctest
extension</a>.</p>
<h3 id="write-doctests" name="write-doctests"><a href="#write-doctests">Write doctests</a></h3>
<p>Here is a RST code sample to write doctests. You can find some doctests
in :doc:/reference/terrain.</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-5"><span class="p">..</span> <span class="ow">highlight</span><span class="p">::</span> python

<span class="p">..</span> <span class="ow">doctest</span><span class="p">::</span>

   &gt;&gt;&gt; print "Hello world!"
   Hello world!
</pre></div>
<p>See <a href="http://sphinx.pocoo.org/ext/doctest.html#module-sphinx.ext.doctest" title="None">Sphinx&#39;s doctest
extension</a>
and <a href="http://docs.python.org/library/doctest.html" title="None">Python&#39;s doctest</a>
documentations for details.</p>
<h3 id="run-doctests" name="run-doctests"><a href="#run-doctests">Run doctests</a></h3>
<p>Go to lettuce folder and use the provided Makefile:</p>
<div class="highlight"><pre name="contributing-to-the-documentation-example-6"><span class="n">make</span> <span class="n">doctests</span>
</pre></div><h2 id="references" name="references"><a href="#references">References</a></h2>
        </div>
      </div>
    </div> <!-- /container -->

    <footer>
      <div class="container">
        <div class="row">
          <div class="span7">
            <h3 class="footer-title">Lettuce</h3>
            <p>Lettuce is maintained by gabrielfalcao. <br />
              This documentation was generated automatically by <a href="http://octomarks.io/gabrielfalcao/markment">Markment</a>.
            </p>
            <p>
              This theme was written by Gabriel Falcão using the <a href="http://designmodo.github.io/Flat-UI/">Flat-UI</a> library by
              <a class="footer-brand" href="http://designmodo.com" target="_blank">
                <img src="../assets/images/footer/logo.png" alt="Designmodo.com">
              </a>
            </p>
          </div> <!-- /span8 -->

          <div class="span5">
            <div class="footer-banner">
              <h3 class="footer-title">Table of contents</h3>
              <ul>
                 
                <li>
                  <a href="../contents.html">
                        contents.md
                  </a>
                </li>
                 
                <li>
                  <a href="../index.html">
                        index.md
                  </a>
                </li>
                 
                <li>
                  <a href="./documentation.html">
                        documentation.md
                  </a>
                </li>
                 
                <li>
                  <a href="./index.html">
                        index.md
                  </a>
                </li>
                 
                <li>
                  <a href="./install-debian-squeeze.html">
                        install-debian-squeeze.md
                  </a>
                </li>
                 
                <li>
                  <a href="./install.html">
                        install.md
                  </a>
                </li>
                 
                <li>
                  <a href="./testing.html">
                        testing.md
                  </a>
                </li>
                 
                <li>
                  <a href="../intro/install.html">
                        install.md
                  </a>
                </li>
                 
                <li>
                  <a href="../intro/overview.html">
                        overview.md
                  </a>
                </li>
                 
                <li>
                  <a href="../intro/wtf.html">
                        wtf.md
                  </a>
                </li>
                 
                <li>
                  <a href="../recipes/django-lxml.html">
                        django-lxml.md
                  </a>
                </li>
                 
                <li>
                  <a href="../recipes/nose.html">
                        nose.md
                  </a>
                </li>
                 
                <li>
                  <a href="../reference/cli.html">
                        cli.md
                  </a>
                </li>
                 
                <li>
                  <a href="../reference/features.html">
                        features.md
                  </a>
                </li>
                 
                <li>
                  <a href="../reference/languages.html">
                        languages.md
                  </a>
                </li>
                 
                <li>
                  <a href="../reference/terrain.html">
                        terrain.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/django.html">
                        django.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/multiline.html">
                        multiline.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/scenario-outlines.html">
                        scenario-outlines.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/simple.html">
                        simple.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/steps-from-step-definitions.html">
                        steps-from-step-definitions.md
                  </a>
                </li>
                 
                <li>
                  <a href="../tutorial/tables.html">
                        tables.md
                  </a>
                </li>
                 
              </ul>
            </div>
          </div>
        </div>
      </div>
    </footer>
  </body>
</html>